<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Register a callback to allow cancellation during archive close.</title>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />

 </head>
 <body class="docs"><div class="navbar navbar-fixed-top">
  <div class="navbar-inner clearfix">
    <ul class="nav" style="width: 100%">
      <li style="float: left;"><a href="ziparchive.open.html">« ZipArchive::open</a></li>
      <li style="float: right;"><a href="ziparchive.registerprogresscallback.html">ZipArchive::registerProgressCallback »</a></li>
    </ul>
  </div>
</div>
<div id="breadcrumbs" class="clearfix">
  <ul class="breadcrumbs-container">
    <li><a href="index.html">PHP Manual</a></li>
    <li><a href="class.ziparchive.html">ZipArchive</a></li>
    <li>Register a callback to allow cancellation during archive close.</li>
  </ul>
</div>
<div id="layout">
  <div id="layout-content"><div id="ziparchive.registercancelcallback" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ZipArchive::registerCancelCallback</h1>
  <p class="verinfo">(PHP &gt;= 8.0.0, PECL zip &gt;= 1.17.0)</p><p class="refpurpose"><span class="refname">ZipArchive::registerCancelCallback</span> &mdash; <span class="dc-title">Register a callback to allow cancellation during archive close.</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-ziparchive.registercancelcallback-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>ZipArchive::registerCancelCallback</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>): <span class="type">bool</span></div>

  <p class="para rdfs-comment">
   Register a <code class="parameter">callback</code> function to allow cancellation during archive close. 
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-ziparchive.registercancelcallback-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt>
<code class="parameter">callback</code></dt>

     <dd>

      <p class="para">
       If this function return 0 operation will continue, other value it will be cancelled.
      </p>
     </dd>

    
   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-ziparchive.registercancelcallback-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   成功时返回 <strong><code>true</code></strong>， 或者在失败时返回 <strong><code>false</code></strong>。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-ziparchive.registercancelcallback-examples">
  <h3 class="title">范例</h3>
    <p class="para">
     This example creates a ZIP file archive
     <var class="filename">php.zip</var> and cancel
     operation on some run condition.
    </p>
    <div class="example" id="example-857">
     <p><strong>示例 #1 Archive a file</strong></p>
     <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$zip&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">();<br />if&nbsp;(</span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #DD0000">'php.zip'</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">CREATE&nbsp;</span><span style="color: #007700">|&nbsp;</span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">OVERWRITE</span><span style="color: #007700">))&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addFile</span><span style="color: #007700">(</span><span style="color: #0000BB">PHP_BINARY</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'php'</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">registerCancelCallback</span><span style="color: #007700">(function&nbsp;()&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;(</span><span style="color: #0000BB">$someruncondition&nbsp;</span><span style="color: #007700">?&nbsp;-</span><span style="color: #0000BB">1&nbsp;</span><span style="color: #007700">:&nbsp;</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;});<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">close</span><span style="color: #007700">();<br />}</span>
</span>
</code></div>
     </div>

    </div>
 </div>


 <div class="refsect1 notes" id="refsect1-ziparchive.registercancelcallback-notes">
  <h3 class="title">注释</h3>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    This function is only available if built against libzip ≥ 1.6.0.
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-ziparchive.registercancelcallback-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="methodname"><a href="ziparchive.registerprogresscallback.html" class="methodname" rel="rdfs-seeAlso">ZipArchive::registerProgressCallback()</a> - Register a callback to provide updates during archive close.</span></li>
   </ul>
  </p>
 </div>


</div></div></div></body></html>